Skip to main content

ARDK for Android/com.nianticlabs.ardk/ArdkConfiguration

ArdkConfiguration

[androidJvm]
object ArdkConfiguration

Kotlin configuration structures mirroring Swift ArdkSession.Configuration.

These are value types used to construct a full ARDK configuration when callers want explicit control over all parameters (vs. using defaults or JSON file).

The nested types correspond to ARDK C-ABI structs and are intentionally nullable to allow partial specification, matching Swift's optional fields.

Types​

NameSummary
CloudEnvConfig[androidJvm]
data class CloudEnvConfig(val vpsEndpoint: String? = null, val vpsCoverageEndpoint: String? = null, val identityEndpoint: String? = null, val portalEndpoint: String? = null, val sharedArEndpoint: String? = null, val fastDepthEndpoint: String? = null, val mediumDepthEndpoint: String? = null, val smoothDepthEndpoint: String? = null, val fastSemanticsEndpoint: String? = null, val mediumSemanticsEndpoint: String? = null, val smoothSemanticsEndpoint: String? = null, val scanningEndpoint: String? = null, val scanningSqcEndpoint: String? = null, val objectDetectionEndpoint: String? = null, val telemetryEndpoint: String? = null, val telemetryKey: String? = null)
Cloud service endpoints used by various ARDK features.
Configuration[androidJvm]
data class Configuration(val forceDisableCTrace: Boolean = false, val deviceInfo: ArdkConfiguration.DeviceInfo = DeviceInfo(), val envConfig: ArdkConfiguration.CloudEnvConfig = CloudEnvConfig(), val userConfig: ArdkConfiguration.UserConfig = UserConfig(), val useLidar: Boolean = false, val logCallback: ArdkLogCallback? = null)
Top-level ARDK configuration container.
DeviceInfo[androidJvm]
data class DeviceInfo(val appId: String? = null, val platform: String? = null, val manufacturer: String? = null, val deviceModel: String? = null, val clientId: String? = null, val appInstanceId: String? = null, val deviceLidarSupported: Boolean = false)
Device metadata used by ARDK for telemetry and platform-specific behavior.
UserConfig[androidJvm]
data class UserConfig(val apiKey: String? = null, val accessToken: String? = null, val refreshToken: String? = null, val featureFlagFilePath: String? = null)
User configuration including API key and auth-related inputs.